.\"	$OpenBSD: DSA_set_method.3,v 1.12 2024/05/11 06:53:19 tb Exp $
.\"	OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
.\"
.\" This file was written by Ulf Moeller <ulf@openssl.org>.
.\" Copyright (c) 2000, 2002, 2007 The OpenSSL Project.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\"
.\" 3. All advertising materials mentioning features or use of this
.\"    software must display the following acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
.\"
.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
.\"    endorse or promote products derived from this software without
.\"    prior written permission. For written permission, please contact
.\"    openssl-core@openssl.org.
.\"
.\" 5. Products derived from this software may not be called "OpenSSL"
.\"    nor may "OpenSSL" appear in their names without prior written
.\"    permission of the OpenSSL Project.
.\"
.\" 6. Redistributions of any form whatsoever must retain the following
.\"    acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd $Mdocdate: May 11 2024 $
.Dt DSA_SET_METHOD 3
.Os
.Sh NAME
.Nm DSA_set_default_method ,
.Nm DSA_get_default_method ,
.Nm DSA_set_method ,
.Nm DSA_new_method ,
.Nm DSA_OpenSSL
.Nd select DSA method
.Sh SYNOPSIS
.In openssl/dsa.h
.Ft void
.Fo DSA_set_default_method
.Fa "const DSA_METHOD *meth"
.Fc
.Ft const DSA_METHOD *
.Fn DSA_get_default_method void
.Ft int
.Fo DSA_set_method
.Fa "DSA *dsa"
.Fa "const DSA_METHOD *meth"
.Fc
.Ft DSA *
.Fo DSA_new_method
.Fa "ENGINE *engine"
.Fc
.Ft DSA_METHOD *
.Fn DSA_OpenSSL void
.Sh DESCRIPTION
A
.Vt DSA_METHOD
object contains pointers to the functions used for DSA operations.
By default, the internal implementation returned by
.Fn DSA_OpenSSL
is used.
By selecting another method, alternative implementations
such as hardware accelerators may be used.
.Pp
.Fn DSA_set_default_method
selects
.Fa meth
as the default method for all
.Vt DSA
structures created later.
.Pp
.Fn DSA_get_default_method
returns a pointer to the current default method.
.Pp
.Fn DSA_set_method
selects
.Fa meth
to perform all operations using the key
.Fa dsa .
This replaces the
.Vt DSA_METHOD
used by the DSA key.
It is possible to have DSA keys that only work with certain
.Vt DSA_METHOD
implementations,
and in such cases attempting to change the
.Vt DSA_METHOD
for the key can have unexpected results.
.Pp
.Fn DSA_new_method
allocates and initializes a
.Vt DSA
structure.
The
.Fa engine
argument is ignored and
the default method controlled by
.Fn DSA_set_default_method
is used.
.Pp
The
.Vt DSA_METHOD
structure is defined as follows:
.Bd -literal
struct {
	/* name of the implementation */
	const char *name;
	/* sign */
	DSA_SIG *(*dsa_do_sign)(const unsigned char *dgst, int dlen,
	    DSA *dsa);
	/* pre-compute k^-1 and r */
	int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
	    BIGNUM **rp);
	/* verify */
	int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len,
	    DSA_SIG *sig, DSA *dsa);
	/* called at DSA_new */
	int (*init)(DSA *DSA);
	/* called at DSA_free */
	int (*finish)(DSA *DSA);
	int flags;
} DSA_METHOD;
.Ed
.Sh RETURN VALUES
.Fn DSA_OpenSSL
and
.Fn DSA_get_default_method
return pointers to the respective
.Vt DSA_METHOD .
.Pp
.Fn DSA_set_method
returns 1 on success or 0 on failure.
Currently, it cannot fail.
.Pp
.Fn DSA_new_method
returns
.Dv NULL
and sets an error code that can be obtained by
.Xr ERR_get_error 3
if the allocation fails.
Otherwise it returns a pointer to the newly allocated structure.
.Sh SEE ALSO
.Xr DSA_meth_new 3 ,
.Xr DSA_new 3
.Sh HISTORY
.Fn DSA_set_default_method ,
.Fn DSA_get_default_method ,
.Fn DSA_set_method ,
.Fn DSA_new_method ,
and
.Fn DSA_OpenSSL
first appeared in OpenSSL 0.9.5 and have been available since
.Ox 2.7 .
